Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 27, 2025

add CloseButtonIcon/ConfirmButtonIcon parameter

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5454

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Adds CloseButtonIcon and ConfirmButtonIcon parameters to the PopConfirmButton component to allow developers to customize the icons displayed on the close and confirm buttons.

New Features:

  • Adds the ability to customize the icons for the close and confirm buttons in the PopConfirmButton component.

Tests:

  • Adds tests to verify the new CloseButtonIcon and ConfirmButtonIcon parameters in the PopConfirmButton component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 27, 2025

Reviewer's Guide by Sourcery

This pull request introduces the ability to customize the close and confirm button icons in the PopConfirmButton component by adding the CloseButtonIcon and ConfirmButtonIcon parameters. The changes include modifications to the component's razor files, addition of new properties, and updates to the unit tests.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added CloseButtonIcon and ConfirmButtonIcon parameters to the PopConfirmButton component to allow users to customize the icons for the close and confirm buttons.
  • Added CloseButtonIcon property to PopConfirmButtonBase.
  • Added ConfirmButtonIcon property to PopConfirmButtonBase.
  • Added CloseButtonIcon property to PopConfirmButtonContent.
  • Added ConfirmButtonIcon property to PopConfirmButtonContent.
  • Updated OnParametersSet method in PopConfirmButtonContent to set default values for the new icon properties using IconTheme.
  • Modified PopConfirmButtonContent.razor to include the new icon parameters in the rendering of the close and confirm buttons.
  • Added new icon keys for PopConfirmButtonContentCloseButtonIcon and PopConfirmButtonContentConfirmButtonIcon to ComponentIcons enum.
  • Updated BootstrapIcons.cs, MaterialDesignIcons.cs, and FontAwesomeIcons.cs to include default icon values for the new icon keys.
  • Updated PopConfirmButton.razor to pass the new icon parameters to PopConfirmButtonContent.
src/BootstrapBlazor/Components/Button/PopConfirmButtonContent.razor.cs
src/BootstrapBlazor/Components/Button/PopConfirmButtonBase.cs
src/BootstrapBlazor/Components/Button/PopConfirmButtonContent.razor
src/BootstrapBlazor/Enums/ComponentIcons.cs
src/BootstrapBlazor/Icons/BootstrapIcons.cs
src/BootstrapBlazor/Icons/MaterialDesignIcons.cs
src/BootstrapBlazor/Icons/FontAwesomeIcons.cs
src/BootstrapBlazor/Components/Button/PopConfirmButton.razor
Updated unit tests for the PopConfirmButton component to include tests for the new CloseButtonIcon and ConfirmButtonIcon parameters.
  • Added assertions to check for the presence of the new icons in the rendered output.
  • Added parameters CloseButtonIcon and ConfirmButtonIcon to the component being tested.
test/UnitTest/Components/PopConfirmButtonTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5454 Add CloseButtonIcon and ConfirmButtonIcon parameters to the PopConfirmButton component.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 27, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 27, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 27, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding the new CloseButtonIcon and ConfirmButtonIcon properties to the demo page to showcase their usage.
  • The test ConfirmIcon_Ok was renamed to Icon_Ok, but it seems to be testing the new icon properties rather than the original Icon property, consider renaming it to CloseButtonIcon_ConfirmButtonIcon_Ok.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang enabled auto-merge (squash) February 27, 2025 00:41
@ArgoZhang
Copy link
Member Author

@sourcery-ai review

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 27, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The unit tests should verify that the correct icons are rendered based on the parameters passed to the component.
  • Consider adding a demo to showcase the new icon customization feature.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang
Copy link
Member Author

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a demo to showcase the new CloseButtonIcon and ConfirmButtonIcon parameters.
  • The unit test ConfirmIcon_Ok was renamed to Icon_Ok but it only tests the default icons, can you add a test case for the new parameters?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c174ff7) to head (e412d91).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5455   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          646       646           
  Lines        29346     29358   +12     
  Branches      4129      4131    +2     
=========================================
+ Hits         29346     29358   +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 441532b into main Feb 27, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-pop2-button branch February 27, 2025 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(PopConfirmButton): add CloseButtonIcon/ConfirmButtonIcon parameter

2 participants